New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Integrations v2 update #439

Merged

novalisdenahi merged 24 commits into master from integrations-v2-update

Dec 10, 2024

Contributor

novalisdenahi commented May 14, 2024

Description

Jira / Trello/ monday.com and VSCode integration docs update. Change linked images and text to be up-to-date with V2.

V1 docs will be updated after the V2 versions are finalized.

Trello card

Notes for QA

The description and the images for the 4 integrations should not contain any V1 information.

Requirement checklist

I have validated my changes on a test/local environment.
I have added my changes to the V1 and V2 documentations.
I have checked the SNYK/Dependabot reports and applied the suggested changes.
(Optional) I have updated outdated packages.

novalisdenahi added 5 commits

April 30, 2024 16:39


          Jira and Trello docs update

d9bf671


          Jira and Trello docs update with new gifs

2245b19


          Fix typos

3aab1b5


          monday and vscode docs update

f180017


          monday abd vsCode updates. fix Jira missing info box

c0fdc23

cloudflare-workers-and-pages bot commented May 17, 2024 •

edited

Loading

Deploying configcat-docs with Cloudflare Pages

Latest commit:	`9f89274`
Status:	✅ Deploy successful!
Preview URL:	https://00fc4144.docs-xmy.pages.dev
Branch Preview URL:	https://integrations-v2-update.docs-xmy.pages.dev

novalisdenahi added 3 commits

May 28, 2024 14:37


          Grammarly update

db8a9ab


          Merge branch 'integrations-v2-update' of https://github.com/configcat…

b0d6e74

…/docs into integrations-v2-update


          Fix monday info panel

c27b1a2

sigewuzhere reviewed

View reviewed changes

website/docs/integrations/jira.mdx Outdated

 . Click authorize.
-              > Every Jira user should authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Jira Cloud Plugin.
+              :::info
+              Every Jira user should authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Jira Cloud Plugin.

Contributor

sigewuzhere May 22, 2024

Suggested change

      
            Every Jira user should authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Jira Cloud Plugin.
          
            Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Jira Cloud Plugin.

just guessing

website/docs/integrations/jira.mdx Outdated

+              ### Linking existing feature flags
+. Navigate to any Issue on your Jira board.
+. Open `ConfigCat Feature Flag` issue context.

Contributor

sigewuzhere May 22, 2024

Suggested change

      
            2. Open `ConfigCat Feature Flag` issue context.
          
            2. Open the `ConfigCat Feature Flag` issue context.

website/docs/integrations/jira.mdx Outdated

+. Navigate to any Issue on your Jira board.
+. Open `ConfigCat Feature Flag` issue context.
+. On the `Link existing` tab select a ConfigCat Product, Config, Environment and a Feature Flag to be linked to your issue.
+. When linked, you can turn your features On / Off right from this Issue.

Contributor

sigewuzhere May 22, 2024

Suggested change

      
            4. When linked, you can turn your features On / Off right from this Issue.
          
            4. When linked, you can manage the selected feature flag from this Issue.

website/docs/integrations/jira.mdx Outdated

+              <img src="/docs/assets/jira/link-existing.gif" className="zoomable" alt="Linking existing feature flags in Jira Cloud Plugin" />
+              ### View and Edit linked feature flags
 . Open an Issue on your Jira board with linked feature flag.
 . You can see the linked feature flags in the `Feature Flag (ConfigCat)` issue section.
 . You can turn your features On / Off right from this Issue.

Contributor

sigewuzhere May 22, 2024

same as above

website/docs/integrations/jira.mdx Outdated

-. You can add new Targeting Rules, target a new segment or target a percentage of users.
-. You can remove Targeting Rules as well.
-. To see the feature flag on the ConfigCat Dashboard just use the `Open in ConfigCat` link.
+. You can add new Targeting Rules with User, Segment or Prerequisite conditions with large selection of Comparators.

Contributor

sigewuzhere May 22, 2024

might be a good idea to to link connecting docs pages

website/docs/integrations/jira.mdx Outdated

-. Open a version in the project Release Hub to see the related issues feature flag status.
-. Click it for more detailed dialog.
+              :::info
+              The plugin doesn't implement the Releases - Create/Connect feature flag actions. However, it provides the same actions without the necessity of navigating outside the Jira instance.

Contributor

sigewuzhere Jun 4, 2024

Let's discuss this in person. I'm not sure what it means.


          Replace black theme gifs and updates based on code review.

novalisdenahi requested a review from sigewuzhere

June 10, 2024 15:24

sigewuzhere added 2 commits

June 10, 2024 17:48


          releases action

23fc713


          read more

ed99d34

sigewuzhere previously approved these changes

View reviewed changes


          Fix read more about in the other integrations as well.

2acacbb

novalisdenahi dismissed sigewuzhere’s stale review via

2acacbb

June 11, 2024 12:10

novalisdenahi added 4 commits

June 14, 2024 09:49


          Fix V1 and V2 pictures

ed6128c


          Update V1 descriptions

4d662da


          Update Jira V1 gifs to latest

aee1bb9


          Update Trello V1 gifs to latest

c06a9a7

novalisdenahi requested a review from sigewuzhere

June 14, 2024 14:59

Contributor Author

novalisdenahi commented Jun 14, 2024

@sigewuzhere The V1 docs are updated

sigewuzhere previously approved these changes

View reviewed changes

novalisdenahi marked this pull request as ready for review

June 21, 2024 09:48

novalisdenahi requested a review from a team as a code owner

June 21, 2024 09:48

zoltan-david reviewed

View reviewed changes

website/docs/integrations/jira.mdx


		## Installation
		Turn features On/Off right from a linked Issue on your Jira board. You can also easily modify the linked flags to edit or add new Targeting or Percentage Rules.

Member

zoltan-david Jul 18, 2024

Ez a mondat az értékeajánlat. Az a szerepe, hogy megértse a user, hogy mire tudná használni ezt az integrációt. Ezért ennek a mondatnak a leírás legelején van értelme. Az Installation szekcióban szerintem nincsen sok haszna már.

Azt jvaslom, hogy mozgassuk vissza a doksi elejére. Akár az új kezdőmondat elé vagy mögé.

Contributor Author

novalisdenahi Aug 1, 2024

A doksi elején van. Pont az installation szekció került hátrább.

website/docs/integrations/jira.mdx


		## Usage

		### Linking existing feature flags

Member

zoltan-david Jul 18, 2024

Általában véve azért lenne jobb ha a “Link existing” use case előbb szerepelne, mint a “Create new”, mert a “Link existing” sokkal gyakoribb.

Ugyanakkor itt a ConfigCat doksiban megértem ezt a sorrendet is, de más helyeken pl. a JIRA oldalán mindenképpen a "Link existing" legyen előbb.

Contributor Author

novalisdenahi Aug 1, 2024

Szerintem kiegyezhetünk midnenütt a link existing és create sorrendben. Egységesen appokban és doksiban is. Módsoítom ennek megfelően.

website/docs/integrations/jira.mdx Outdated

-. Open an Issue on your Jira board with linked feature flag.
-. Check the `Releases` field values in the issue Details section to see the linked feature flags status in the Issue.
-. Click it for more detailed dialog.
+. Open a version in the project Release Hub to see the related issues feature flag status.

Member

zoltan-david Jul 18, 2024

Itt a Release Hub-ot hívjuk Jira Release Hub-nak légyszi.
Az az alapelv, hogy sok userünk nem ismeri mélyen sem a Jirat, sem a ConfigCatet.
Nekik segítünk azzal, hogy megnevezzük melyik toolban kezdjen el keresgélni.
Szóval a contextust (ConfigCat vagy Jira) áltlában megnevezzük legalább egyszer, legalább a felsorolások első pontjaiban.

website/docs/integrations/monday.mdx Outdated

-. Add the ConfigCat Feature Flags monday app to your item.
-. In order to use ConfigCat Feature Flags you have to authorize first with your ConfigCat Public API credentials.
-. Get your ConfigCat Public API credentials: https://app.configcat.com/my-account/public-api-credentials
+. Open one of your boards on monday and click on an Item.

Member

zoltan-david Jul 18, 2024

Ez biztosan "on" monday, és nem "in" monday?
Mert szerintem in "in" Jira, és biztosan nem "on" Jira.

Az "on monday" az szerintem azt jelenti, hogy "hétfőn".

Ennek ellenére, ha a Monday-esek "on monday"-ként szoktak beszélni a saját tooljukról, akkor felőlem maradhat így. Különben szerintem érdemes "in"-re cserélni.

Member

zoltan-david Jul 18, 2024

Esetleg lehetne on monday.com

website/docs/integrations/trello.mdx


		## Installation
		Turn features On/Off right from a linked card on your Trello board. You can also easily modify the linked flags to edit or add new Targeting or Percentage Rules.

Member

zoltan-david Jul 18, 2024

Ez is egy értékajánlat, itt is azt javaslom, hogy ne az Installation szekcióban legyen, hanem a doksumentum elején az első egy-két mondatban.

Contributor Author

novalisdenahi Aug 1, 2024

A doksi elején van. Pont az installation szekció került hátrább.

website/docs/integrations/vscode.mdx Outdated


		1. Search for ConfigCat Feature Flags at the Extensions page.
		1. Search for ConfigCat Feature Flags on the Extensions page.

Member

zoltan-david Jul 18, 2024

Javaslom, hogy az első pontban mindig nevezzük meg a toolt (bár látom, hogy itt a cím sokat segít).

Valami ilyet javaslok:
In Visual Studio Code, open the Extensions page, and search for ConfigCat Feature Flags.

website/docs/integrations/vscode.mdx Outdated

               ### Advanced
-              If you are trying to use the ConfigCat Feature Flags extension for Visual Studio Code with a `dedicated hosted`/[on-premise](https://configcat.com/on-premise/) ConfigCat instance, you can specify your custom urls by executing the `Preferences: Open Workspace Settings` command from the Command Palette and search for `Extensions/ConfigCat` or clicking the manage button on the ConfigCat Feature Flags extension's page. Important settings:
+              If you are trying to use the ConfigCat Feature Flags extension for Visual Studio Code with a `dedicated hosted`/[on-premise](https://configcat.com/on-premise/) ConfigCat instance. In that case, you can specify your custom URLs by executing the `Preferences: Open Workspace Settings` command from the Command Palette and searching for `Extensions/ConfigCat` or clicking the manage button on the ConfigCat Feature Flags extension's page. Important settings:

Member

zoltan-david Jul 18, 2024

Szuper, hogy kettétörted azt a nagy mondatot!

Viszont így az első mondatnak önmagában nincs igazi tartalma.

És én "a you are trying to use" helyett is "you use"-t használnék, mert a nem anyanelyvi angoloknak sokat segít.

Valami ilyesmit javaslok:

This section is for you if you use a dedicated hosted/[on-premise](https://configcat.com/on-premise/) ConfigCat instance. In that case, you must specify your custom ConfigCat URLs in Visual Studio Code. You can do that by executing the Preferences: Open Workspace Settingscommand from the Command Palette and searching forExtensions/ConfigCat` or clicking the manage button on the ConfigCat Feature Flags extension's page. Important settings:

website/docs/integrations/vscode.mdx Outdated


		## Usage of ConfigCat Feature Flags Views

		The ConfigCat Feature Flags Views can be opened by clicking the ConfigCat Feature Flags icon on the Activity Bar. There are three different views.

Member

zoltan-david Jul 18, 2024

Én itt is kiírnaám, hogy a "Visual Studio Code" az "Activity Bar" környékére.

website/docs/integrations/vscode.mdx Outdated


		### Feature Flags & Settings View

		After you successfully connect a Config to your Workspace from the Feature Flags & Settings View, you can:

Member

zoltan-david Jul 18, 2024

Suggested change

      
            After you successfully connect a Config to your Workspace from the Feature Flags & Settings View, you can:
          
            After you successfully connect your ConfigCat Config to your Visual Studio Code Workspace, open the Feature Flags & Settings View and:

website/docs/integrations/vscode.mdx Outdated

-              ### or install from VSIX file
+              ### Install from VSIX file
 . Open [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags) at Visual Studio Marketplace.

Member

zoltan-david Jul 18, 2024

Suggested change

      
            1. Open [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags) at Visual Studio Marketplace.
          
            1. Visual Studio Marketplace, open the [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags).

Contributor Author

novalisdenahi Aug 13, 2024

Add In to the beginning


          Updates based on Zoli review.

9fcd09c

novalisdenahi dismissed sigewuzhere’s stale review via

9fcd09c

August 1, 2024 22:20


          Small fixes

novalisdenahi added 6 commits

November 5, 2024 16:14


          Update VSCode gifs and description

568edf8


          Update Trello gifs

d4a10e2


          Update Monday gifs

a4e09e9


          Update Jira gifs

7a2bf7e


          Merge branch 'master' into integrations-v2-update

83b987b


          Update image border css

9f89274

novalisdenahi requested a review from zoltan-david

December 9, 2024 15:19

laliconfigcat approved these changes

View reviewed changes

novalisdenahi merged commit 0dd949b into master

3 checks passed

novalisdenahi deleted the integrations-v2-update branch

December 10, 2024 13:34

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet